package datastructure.linked;

/**
 * 双向链表(带哨兵)
 *
 * @author 杨 强
 * @package datastructure.linked
 * @createTime 2023-03-12 16:08
 */
public class DoublyLinkedListSentinel {
    /**
     * 链表的头部哨兵
     */
    Node head;
    /**
     * 链表的尾部哨兵
     */
    Node tail;

    /**
     * 添加头部节点
     * @param value
     */
    public void addFirst(int value){
        insert(0, value);
    }

    /**
     * 移除头部节点
     */
    public void removeFirst(){
        remove(0);
    }

    /**
     * 移除尾部节点
     */
    public void removeLast(){
        Node removed = tail.prev;
        if (removed == head) {
            throw illegalIndex(0);
        }
        Node prev = removed.prev;
        prev.next = tail;
        tail.prev = prev;
    }

    /**
     * 添加尾部节点
     *      尾部节点就是哨兵未节点的上一个节点
     * @param value
     */
    public void addLast(int value) {
        // 找到尾部节点的上一个节点
        Node prev = tail.prev;
        // 创建新节点
        Node added = new Node(prev, value, tail);
        // 指针变化
        prev.next = added;
        tail.prev = added;
    }

    /**
     * 根据索引位置插入值
     *      确定插入索引位置节点的上一个节点和下一个节点,然后变换指针
     * @param index 索引
     * @param value 值
     */
    public void insert(int index,int value){
        // 新节点上一个节点
        Node prev = findNode(index - 1);
        if (prev == null) {
            throw illegalIndex(index);
        }
        // 新节点的下一个节点
        Node next = prev.next;
        // 创建新节点
        Node inserted = new Node(prev, value, next);
        // 变化指针
        prev.next = inserted;
        next.prev = inserted;
    }

    /**
     * 移除指定索引节点
     *      找打需要删除的节点,和需要删除节点的上一个节点,和需要删除节点的下一个节点然后变化指针
     * @param index 索引
     */
    public void remove(int index){
        // 删除节点的上一个节点
        Node prev = findNode(index - 1);
        if (prev == null) {
            throw illegalIndex(index);
        }
        // 需要删除的节点
        Node removed = prev.next;
        if (removed == tail) {
            throw illegalIndex(index);
        }
        // 需要删除节点的下一个节点
        Node next = removed.next;
        // 变化指针
        prev.next = next;
        next.prev = prev;
    }

    /**
     * 根据索引查找节点
     * @param index 索引
     * @return 节点
     */
    private Node findNode(int index){
        // 从头部哨兵节点开始找,哨兵节点为-1
        int i = -1;
        // 循环查找索引位置
        for (Node p = head; p != tail ; p = p.next, i++) {
            if (i == index){
                return p;
            }
        }
        return null;
    }

    /**
     * 抛出异常
     * @param index 该索引位置不存在链表中
     * @return
     */
    private IllegalArgumentException illegalIndex(int index) {
        return new IllegalArgumentException(String.format("index [%d] 不合法%n", index));
    }

    /**
     * 构造方法,初始化双向链表+头尾哨兵
     */
    public DoublyLinkedListSentinel() {
        this.head = new Node(null, 666, null);
        this.tail = new Node(null, 666, null);
        // 构建双向链表
        this.head.next = this.tail;
        this.tail.prev = this.head;
    }

    /**
     * 双向链表节点类
     */
    static class Node{
        // 上一个节点指针
        Node prev;
        // 值
        int value;
        // 下一个节点指针
        Node next;
        public Node(Node prev, int value, Node next) {
            this.prev = prev;
            this.value = value;
            this.next = next;
        }
    }
}
